<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html><head><title>SASAPI</title><script src="../../quicknav.js" type="text/javascript"></script><script><!--
document.quicknavBasePath="../../index-files";
//--></script><link href="../../style.css" title="JavaDoc" rel="stylesheet" type="text/css"/><link href="../../unnatural.css" title="Unnatural" rel="alternate stylesheet" type="text/css"/><link href="../../overview-summary.html" title="Overview" rel="top"/><meta name="generator" content="http://www.badgers-in-foil.co.uk/projects/as2api/"/></head><body><pre><span class="lineno" id="1">     1  </span><span class="comment doc">/**
<span class="lineno" id="2">     2  </span> * PropertyInfoObj
<span class="lineno" id="3">     3  </span> * An object containing the updating info for a given property (its starting value, its final value, and a few other things)
<span class="lineno" id="4">     4  </span> *
<span class="lineno" id="5">     5  </span> * @author		Zeh Fernando
<span class="lineno" id="6">     6  </span> * @version		1.0.0
<span class="lineno" id="7">     7  </span> * @private
<span class="lineno" id="8">     8  </span> */</span>
<span class="lineno" id="9">     9  </span>
<span class="lineno" id="10">    10  </span><span class="key">class</span> caurina.transitions.PropertyInfoObj {
<span class="lineno" id="11">    11  </span>	
<span class="lineno" id="12">    12  </span>	<span class="key">public</span> <span class="key">var</span> valueStart				:Number;	<span class="comment">// Starting value of the tweening (null if not started yet)</span>
<span class="lineno" id="13">    13  </span>	<span class="key">public</span> <span class="key">var</span> valueComplete			:Number;	<span class="comment">// Final desired value (numerically)</span>
<span class="lineno" id="14">    14  </span>	<span class="key">public</span> <span class="key">var</span> originalValueComplete	:Object;	<span class="comment">// Final desired value as declared initially</span>
<span class="lineno" id="15">    15  </span>	<span class="key">public</span> <span class="key">var</span> arrayIndex				:Number;	<span class="comment">// Index (if this is an array item)</span>
<span class="lineno" id="16">    16  </span>	<span class="key">public</span> <span class="key">var</span> extra					:Object;	<span class="comment">// Additional parameters, used by some special properties</span>
<span class="lineno" id="17">    17  </span>	<span class="key">public</span> <span class="key">var</span> isSpecialProperty		:Boolean;	<span class="comment">// Whether or not this is a special property instead of a direct one</span>
<span class="lineno" id="18">    18  </span>	<span class="key">public</span> <span class="key">var</span> hasModifier				:Boolean;	<span class="comment">// Whether or not it has a modifier function</span>
<span class="lineno" id="19">    19  </span>	<span class="key">public</span> <span class="key">var</span> modifierFunction			:Function;	<span class="comment">// Modifier function, if any</span>
<span class="lineno" id="20">    20  </span>	<span class="key">public</span> <span class="key">var</span> modifierParameters		:Array;		<span class="comment">// Additional array of modifier parameters</span>
<span class="lineno" id="21">    21  </span>
<span class="lineno" id="22">    22  </span>	<span class="comment">// ==================================================================================================================================</span>
<span class="lineno" id="23">    23  </span>	<span class="comment">// CONSTRUCTOR function -------------------------------------------------------------------------------------------------------------</span>
<span class="lineno" id="24">    24  </span>
<span class="lineno" id="25">    25  </span>	<span class="comment doc">/**
<span class="lineno" id="26">    26  </span>	 * Initializes the basic PropertyInfoObj.
<span class="lineno" id="27">    27  </span>	 * 
<span class="lineno" id="28">    28  </span>	 * @param	p_valueStart		Number		Starting value of the tweening (null if not started yet)
<span class="lineno" id="29">    29  </span>	 * @param	p_valueComplete		Number		Final (desired) property value
<span class="lineno" id="30">    30  </span>	 */</span>
<span class="lineno" id="31">    31  </span>	<span class="key">function</span> PropertyInfoObj(p_valueStart:Number, p_valueComplete:Number, p_originalValueComplete:Object, p_arrayIndex:Number, p_extra:Object, p_isSpecialProperty:Boolean, p_modifierFunction:Function, p_modifierParameters:Array) {
<span class="lineno" id="32">    32  </span>		valueStart				=	p_valueStart;
<span class="lineno" id="33">    33  </span>		valueComplete			=	p_valueComplete;
<span class="lineno" id="34">    34  </span>		originalValueComplete	=	p_originalValueComplete;
<span class="lineno" id="35">    35  </span>		arrayIndex				=	p_arrayIndex;
<span class="lineno" id="36">    36  </span>		extra					=	p_extra;
<span class="lineno" id="37">    37  </span>		isSpecialProperty		=	p_isSpecialProperty;
<span class="lineno" id="38">    38  </span>		hasModifier				=	p_modifierFunction != undefined;
<span class="lineno" id="39">    39  </span>		modifierFunction 		=	p_modifierFunction;
<span class="lineno" id="40">    40  </span>		modifierParameters		=	p_modifierParameters;
<span class="lineno" id="41">    41  </span>	}
<span class="lineno" id="42">    42  </span>
<span class="lineno" id="43">    43  </span>
<span class="lineno" id="44">    44  </span>	<span class="comment">// ==================================================================================================================================</span>
<span class="lineno" id="45">    45  </span>	<span class="comment">// OTHER functions ------------------------------------------------------------------------------------------------------------------</span>
<span class="lineno" id="46">    46  </span>
<span class="lineno" id="47">    47  </span>	<span class="comment doc">/**
<span class="lineno" id="48">    48  </span>	 * Clones this property info and returns the new PropertyInfoObj
<span class="lineno" id="49">    49  </span>	 *
<span class="lineno" id="50">    50  </span>	 * @param	omitEvents		Boolean			Whether or not events such as onStart (and its parameters) should be omitted
<span class="lineno" id="51">    51  </span>	 * @return 					TweenListObj	A copy of this object
<span class="lineno" id="52">    52  </span>	 */</span>
<span class="lineno" id="53">    53  </span>	<span class="key">public</span> <span class="key">function</span> clone():PropertyInfoObj {
<span class="lineno" id="54">    54  </span>		<span class="key">var</span> nProperty:PropertyInfoObj = <span class="key">new</span> PropertyInfoObj(valueStart, valueComplete, originalValueComplete, arrayIndex, extra, isSpecialProperty, modifierFunction, modifierParameters);
<span class="lineno" id="55">    55  </span>		<span class="key">return</span> nProperty;
<span class="lineno" id="56">    56  </span>	}
<span class="lineno" id="57">    57  </span>
<span class="lineno" id="58">    58  </span>	<span class="comment doc">/**
<span class="lineno" id="59">    59  </span>	 * Returns this object described as a String.
<span class="lineno" id="60">    60  </span>	 *
<span class="lineno" id="61">    61  </span>	 * @return 					String		The description of this object.
<span class="lineno" id="62">    62  </span>	 */</span>
<span class="lineno" id="63">    63  </span>	<span class="key">public</span> <span class="key">function</span> toString():String {
<span class="lineno" id="64">    64  </span>		<span class="key">var</span> returnStr:String = <span class="str_const">"\n[PropertyInfoObj "</span>;
<span class="lineno" id="65">    65  </span>		returnStr += <span class="str_const">"valueStart:"</span> + String(valueStart);
<span class="lineno" id="66">    66  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="67">    67  </span>		returnStr += <span class="str_const">"valueComplete:"</span> + String(valueComplete);
<span class="lineno" id="68">    68  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="69">    69  </span>		returnStr += <span class="str_const">"originalValueComplete:"</span> + String(originalValueComplete);
<span class="lineno" id="70">    70  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="71">    71  </span>		returnStr += <span class="str_const">"arrayIndex:"</span> + String(arrayIndex);
<span class="lineno" id="72">    72  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="73">    73  </span>		returnStr += <span class="str_const">"extra:"</span> + String(extra);
<span class="lineno" id="74">    74  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="75">    75  </span>		returnStr += <span class="str_const">"isSpecialProperty:"</span> + String(isSpecialProperty);
<span class="lineno" id="76">    76  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="77">    77  </span>		returnStr += <span class="str_const">"hasModifier:"</span> + String(hasModifier);
<span class="lineno" id="78">    78  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="79">    79  </span>		returnStr += <span class="str_const">"modifierFunction:"</span> + String(modifierFunction);
<span class="lineno" id="80">    80  </span>		returnStr += <span class="str_const">", "</span>;
<span class="lineno" id="81">    81  </span>		returnStr += <span class="str_const">"modifierParameters:"</span> + String(modifierParameters);
<span class="lineno" id="82">    82  </span>		returnStr += <span class="str_const">"]\n"</span>;
<span class="lineno" id="83">    83  </span>		<span class="key">return</span> returnStr;
<span class="lineno" id="84">    84  </span>	}
<span class="lineno" id="85">    85  </span>	
<span class="lineno" id="86">    86  </span>}
<span class="lineno" id="87">    87  </span></pre><ul class="main_nav" id="main_nav"><li><a href="../../overview-summary.html" title="Overview of SASAPI" class="button">Overview</a></li><li><a href="package-summary.html" title="Overview of package caurina.transitions" class="button">Package</a></li><li><a href="PropertyInfoObj.html" title="Detail of caurina.transitions.PropertyInfoObj API" class="button">Class</a></li><li><span class="button nav_current">Source</span></li><li><a href="../../index-files/index.html" title="Alpabetical index of types and members" class="button">Index</a></li></ul><div class="footer"><a href="http://www.badgers-in-foil.co.uk/projects/as2api/" title="ActionScript 2 API Documentation Generator">as2api</a></div></body></html>